docs: align agent example format with official Claude Code documentation#119
docs: align agent example format with official Claude Code documentation#119
Conversation
Update example blocks across agent development documentation and all 3 agents to use the official Claude Code single-assistant-line format with commentary positioned after the assistant invocation line. Key changes: - triggering-examples.md: Updated template and all example types - agent-creator.md: Updated documented template format - plugin-validator.md: Converted 3 examples to single-line format - skill-reviewer.md: Converted 1 example to single-line format The official format uses: - Single assistant line (invocation only) - Commentary positioned after the invocation Fixes #117 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Claude finished @sjnims's task in 1m 22s —— View job PR Review CompleteSummaryAssessment: ✅ Looks good - well-executed alignment with official documentation This PR successfully aligns all agent examples with the official Claude Code documentation format. The changes are consistent, well-documented, and improve clarity. What's Good
Detailed ReviewFile:
|
Summary
<example>blocks in agent development documentation and agents with the official Claude Code documentation formattriggering-examples.mdagent-creator.mdProblem
Fixes #117
The plugin's internal documentation and agents were using a two-assistant-line example format that differed from the official Claude Code documentation:
Solution
Aligned all examples with the official format:
Files Changed
triggering-examples.mdagent-creator.mdplugin-validator.mdskill-reviewer.mdAlternatives Considered
Documenting the intentional difference rather than aligning was considered, but alignment with official documentation was chosen for:
Testing
🤖 Generated with Claude Code